Documents for scancode-license-data #4024 - #4461
Conversation
Signed-off-by: Chin Yeung Li <tli@nexb.com>
Signed-off-by: Chin Yeung Li <tli@nexb.com>
This commit also alphabetizes the options list and reorders `scancode-reindex-licenses` options to match the help output. Signed-off-by: Chin Yeung Li <tli@nexb.com>
AyanSinhaMahapatra
left a comment
There was a problem hiding this comment.
Thanks @chinyeungli looks good.
See my comments for your consideration
| ``scancode-reindex-licenses`` Usage | ||
| ----------------------------------- | ||
|
|
||
| Usage: ``scancode-reindex-licenses [OPTIONS]`` |
There was a problem hiding this comment.
Isn't CLI scripts/othe CLI commands best be wrapped by `` so they are highlighted differently?
There was a problem hiding this comment.
This is not addressed yet, can you revert the changes?
| .. include:: /rst_snippets/scancode-license-data.rst | ||
|
|
||
|
|
||
| ``--path`` Option: |
There was a problem hiding this comment.
This should be inside scancode-license-data.rst
| .. include:: /rst_snippets/scancode-license-data.rst | ||
|
|
||
|
|
||
| ``--path`` Option: |
There was a problem hiding this comment.
This should be inside scancode-license-data.rst
| ``--path`` Option: | ||
| ^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| The ``--path`` option defines the directory where the license data will be stored. |
There was a problem hiding this comment.
Minor, but could you add a line that this is a mandatory option
|
|
||
| The dumped licenses directory look like this:: | ||
|
|
||
| licenses/ |
There was a problem hiding this comment.
Could you also explain that this is available online at scancode-licensedb.aboutcode.org/ (generated from https://github.com/aboutcode-org/scancode-licensedb which is refreshed automatically from scancode each day on new commits) and that someone can open this on their browser locally after using scancode-license-data by doing see /path/index.html
There was a problem hiding this comment.
someone can open this on their browser locally after using scancode-license-data by doing see /path/index.html
I don't understand what does this mean?
Perhaps I can simply say The license data is also avaliable at https://scancode-licensedb.aboutcode.org/ ?
There was a problem hiding this comment.
@chinyeungli do the following from a scancode-toolkit source checkout:
./configure --clean && ./configure --dev && source venv/bin/activate && scancode-reindex-licenses
mkdir licensedb
scancode-license-data --path licensedb
see licensedb/index.html
This will open the licenseDB webpages locally which you can browse (this is also generated by scancode-license-data), this is exactly the same as what we have at
scancode-licensedb.aboutcode.org and how we generate those web pages in https://github.com/aboutcode-org/scancode-licensedb/blob/main/Makefile#L52 which is run automatically and updated daily.
So to summerize, I'd like a line in the docs to show that you can generate and browse this static licensedb website locally.
Signed-off-by: Chin Yeung Li <tli@nexb.com>
| ``scancode-reindex-licenses`` Usage | ||
| ----------------------------------- | ||
|
|
||
| Usage: ``scancode-reindex-licenses [OPTIONS]`` |
There was a problem hiding this comment.
This is not addressed yet, can you revert the changes?
|
|
||
| The dumped licenses directory look like this:: | ||
|
|
||
| licenses/ |
There was a problem hiding this comment.
@chinyeungli do the following from a scancode-toolkit source checkout:
./configure --clean && ./configure --dev && source venv/bin/activate && scancode-reindex-licenses
mkdir licensedb
scancode-license-data --path licensedb
see licensedb/index.html
This will open the licenseDB webpages locally which you can browse (this is also generated by scancode-license-data), this is exactly the same as what we have at
scancode-licensedb.aboutcode.org and how we generate those web pages in https://github.com/aboutcode-org/scancode-licensedb/blob/main/Makefile#L52 which is run automatically and updated daily.
So to summerize, I'd like a line in the docs to show that you can generate and browse this static licensedb website locally.
…de-license-data" #4024 Signed-off-by: Chin Yeung Li <tli@nexb.com>
Fixes #4024 - Added documentation for
scancode-license-dataTasks
Run tests locally to check for errors.
The failing tests don't related to the documentation updated in this PR.
Signed-off-by: Chin Yeung Li tli@nexb.com